GET api/SIMS/GetClientAddresses?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}&companyKey={companyKey}

Gets a list of client addresses. If no client IDs are provided, all the client addresses will be returned.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientIds

The list of client IDs to get the addresses for (Optional)

 Collection of string

Required
companyKey

The company name if the service is connected to multiple SIMS companies (Optional)

 string

Default value is

Body Parameters

N/A


Response Information

Resource Description

List of clients and their addresses

Collection of ClientAddress
NameDescriptionTypeAdditional information
Ref

string

N/A
Client

string

N/A
Contact

string

N/A
Address1

string

N/A
Address2

string

N/A
Address3

string

N/A
Address4

string

N/A
Address5

string

N/A
Email

string

N/A
ReplicId

string

N/A

Response Formats

application/json, text/json

Sample: 
[
  {
    "Ref": "sample string 1",
    "Client": "sample string 2",
    "Contact": "sample string 3",
    "Address1": "sample string 4",
    "Address2": "sample string 5",
    "Address3": "sample string 6",
    "Address4": "sample string 7",
    "Address5": "sample string 8",
    "Email": "sample string 9",
    "ReplicId": "sample string 10"
  },
  {
    "Ref": "sample string 1",
    "Client": "sample string 2",
    "Contact": "sample string 3",
    "Address1": "sample string 4",
    "Address2": "sample string 5",
    "Address3": "sample string 6",
    "Address4": "sample string 7",
    "Address5": "sample string 8",
    "Email": "sample string 9",
    "ReplicId": "sample string 10"
  }
]